package com.xpec.c4.game.utility;

import java.util.Stack;

import org.apache.commons.lang3.StringUtils;

/**
 * 計算程式每個步驟的執行時間，並產生文字 log
 * <p>
 * 使用方法：<br>
 * 1 一開始呼叫 {@link #Begin(String)} 在每一個要計算時間的地方呼叫 {@link #showTime(String)}
 * 就會顯示那個位置目前的執行時間。<br>
 * 2 如果發現某一個點的執行時間特別長，比如某個 method 花了比較多的時間，可以在進入 method 後呼叫
 * {@link #intoNext(String)} 初始下一個階層的時間計算，再繼續呼叫 {@link #showTime(String)}
 * 計算各步驟的時間。<br>
 * 3 當一個 method 結束要 return 之前必須呼叫 {@link #returnPrev(String)} 結束目前的階層並回到上一層。
 * <p>
 * 注意：<br>
 * 因為不同的需求文字輸出方式會不一樣, 比如直接印在 console, 寫到文字 log.... 所以輸出文字的 method
 * {@link #outputText(String)}是空的, 必須繼承後照需求自己去實做。
 * 
 * @author TW15010
 */
public abstract class RunTimeTracker {
	/**
	 * 記錄目前這一個階層的時間狀態
	 * 
	 * @author TW15010
	 */
	public class RunTimeStack {
		/**
		 * 起始時間
		 */
		private long begTime;

		/**
		 * 最後一次更新狀態的時間
		 */
		private long lastUpdateTime;

		public long getBegTime() {
			return begTime;
		}

		public void setBegTime(long begTime) {
			this.begTime = begTime;
		}

		public long getLastUpdateTime() {
			return lastUpdateTime;
		}

		public void setLastUpdateTime(long lastUpdateTime) {
			this.lastUpdateTime = lastUpdateTime;
		}
	}

	/**
	 * 各層級的時間狀態堆疊
	 */
	private Stack<RunTimeStack> timeStack = new Stack<RunTimeStack>();

	/**
	 * 目前這一階層的時間狀態
	 */
	private RunTimeStack curTimeStack;

	/**
	 * 開始分析，將內部資料初始化
	 * 
	 * @param logText
	 *            要顯示的 log 文字
	 */
	public void Begin(String logText) {
		timeStack.clear();
		curTimeStack = createNewStack();
		showTime(logText);
	}

	/**
	 * 建立新的時間狀態
	 * 
	 * @return 時間狀態
	 */
	private RunTimeStack createNewStack() {
		RunTimeStack stack = new RunTimeStack();

		long curTime = System.currentTimeMillis();
		stack.setBegTime(curTime);
		stack.setLastUpdateTime(curTime);

		return stack;
	}

	/**
	 * 產生表示目前時間狀態的字串
	 * 
	 * @param logText
	 *            要顯示的 log 文字
	 * @return 時間狀態文字
	 */
	private String createTimeText(String logText) {
		long curTime = System.currentTimeMillis();

		StringBuilder timeText = new StringBuilder();

		int stackSize = timeStack.size();
		if (stackSize > 0) {
			timeText.append(StringUtils.repeat("	", stackSize));
		}

		timeText.append(GameUtility.remainTimeToString(curTime - curTimeStack.getBegTime()) + " / "
				+ (curTime - curTimeStack.getLastUpdateTime()) + " ms " + logText);

		curTimeStack.setLastUpdateTime(curTime);

		return timeText.toString();
	}

	/**
	 * 進入下一個階層
	 * 
	 * @param logText
	 *            要顯示的 log 文字
	 */
	public void intoNext(String logText) {
		timeStack.push(curTimeStack);
		curTimeStack = createNewStack();
		showTime(logText);
	}

	/**
	 * 回到上一個階層
	 * 
	 * @param logText
	 *            要顯示的 log 文字
	 */
	public void returnPrev(String logText) {
		if (timeStack.size() == 0) {
			return;
		}

		showTime(logText);
		curTimeStack = timeStack.pop();
	}

	/**
	 * 顯示目前這一階段的 log
	 * 
	 * @param logText
	 *            要顯示的 log 文字
	 */
	public void showTime(String logText) {
		if (logText == null) {
			return;
		}

		String timeText = createTimeText(logText);
		outputText(timeText);
	}

	/**
	 * 取得最底層的 stack
	 * 
	 * @return stack
	 */
	private RunTimeStack getRootStack() {
		RunTimeStack stack;
		if (timeStack.size() > 0) {
			stack = timeStack.get(0);
		} else {
			stack = curTimeStack;
		}

		return stack;
	}

	/**
	 * 取得目前階層花費的總時間
	 * 
	 * @return 時間
	 */
	public long getCurrentStackTime() {
		return System.currentTimeMillis() - curTimeStack.getBegTime();
	}

	/**
	 * 取得從一開始到現在所花費的總時間
	 * 
	 * @return 時間
	 */
	public long getTotalTime() {
		RunTimeStack rootStack = getRootStack();
		return System.currentTimeMillis() - rootStack.getBegTime();
	}

	/**
	 * 取得上一次更新到現在花費的時間
	 * 
	 * @return 時間
	 */
	public long getTimeFromLastUpdate() {
		return System.currentTimeMillis() - curTimeStack.getLastUpdateTime();
	}

	/**
	 * 將產生的 log 輸出，依照需求自己實做。
	 * 
	 * @param logText
	 *            要被輸出的 log 字串
	 */
	public abstract void outputText(String logText);
}
